Introduce TempFileService and lifecycle cleanup participant by arturobernalg · Pull Request #11405 · apache/maven

arturobernalg · 2025-11-07T12:54:29Z

Following this checklist to help us incorporate your
contribution quickly and easily:

[X ] Your pull request should address just one issue, without pulling in other changes.
[ X] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
[ X] Each commit in the pull request should have a meaningful subject line and body.
Note that commits might be squashed by a maintainer on merge.
[X ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
This may not always be possible but is a best-practice.
[X ] Run mvn verify to make sure basic checks pass.
A more thorough check will be performed on your pull request automatically.

You have run the [Core IT](https://maven.apache.org/core-its/core-it-suite/) successfully.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.

…irs on afterSessionEnd; opt-out via -Dmaven.tempfile.keep Add tests and minimal SessionData map stub

gnodet · 2025-11-07T20:49:14Z

It looks like a duplicate of #11389 ?

arturobernalg · 2025-11-08T15:51:07Z

It looks like a duplicate of #11389 ?

Yes. one for master and the other for maven-4.X

gnodet

Small change needed

gnodet · 2025-11-07T20:47:22Z

+     * System property to keep temp material for diagnostics.
+     *
+     */
+    public static final String KEEP_PROP = "maven.tempfile.keep";


Rename to MAVEN_TEMPFILE_KEEP for consistency.

gnodet

Review: Introduce TempFileService and lifecycle cleanup participant

The concept is sound — providing a managed temp file service with automatic cleanup at session end is a useful addition. However, there are several API design issues that should be addressed before merging into the Maven 4 API.

High

@Nonnull on void return methods — TempFileService.register() and cleanup() have @Nonnull on their void return type. This is semantically meaningless — void methods have no return value to be null or non-null. Other services (e.g., ArtifactManager.setPath()) do not annotate void returns with @Nonnull. Remove @Nonnull from these two methods and instead annotate the parameters.

Medium

KEEP_PROP naming convention (Constants.java) — Every other constant in Constants.java uses the MAVEN_ prefix (113 occurrences). The new constant should follow suit: MAVEN_TEMPFILE_KEEP instead of KEEP_PROP.
Missing @Experimental annotation (TempFileService.java) — Every other Service interface in org.apache.maven.api.services carries @Experimental (ArtifactResolver, ArtifactManager, Interpolator, etc.). This should too.
Boolean.getBoolean(KEEP_PROP) reads JVM system property (DefaultTempFileService.java) — Boolean.getBoolean() only checks System.getProperty(), so the property cannot be set via pom.xml <properties>, profiles, or settings.xml. Consider using session.getUserProperties() or session.getSystemProperties() if this should be settable through Maven's property resolution. If this is intentionally a JVM-level diagnostic flag, that's fine — just document the rationale.
Missing @since and @Config (Constants.java) — All recent constant additions have @since 4.1.0 and a @Config annotation (e.g., MAVEN_CACHE_STATS, MAVEN_MODEL_PROCESSOR_POOLED_TYPES). Both are missing here.

Low

Parameters missing @Nonnull/@Nullable (TempFileService.java) — Other services in this package annotate all parameters (Interpolator, ArtifactManager). The session and directory parameters should be @Nonnull; clarify whether prefix/suffix accept null (they do per java.nio.file.Files contract).
Logger created inline (TempFileCleanupParticipant.java) — The logger is created at the call site: LoggerFactory.getLogger(TempFileCleanupParticipant.class).warn(...). This is inconsistent with DefaultTempFileService in the same PR, which correctly uses a private static final Logger LOGGER field. Extract to a field.
System.setProperty in tests (DefaultTempFileServiceTest.java) — System.setProperty mutates global JVM state and can cause test pollution in parallel execution. Also, there is no test for TempFileCleanupParticipant itself.
Raw type cast for TMP_KEY (DefaultTempFileService.java) — The @SuppressWarnings({"unchecked", "rawtypes"}) cast is acknowledged and documented. Consider a wrapper type to avoid the raw cast, or accept it as a known limitation of SessionData.Key generics.

Notes

The companion PR #11389 targeting maven-4.X is closed. Please confirm this is the intended target branch.
The PR description is minimal — for a new public API addition, documenting the motivation (what temp files are currently leaked, which plugins benefit) would help reviewers.
Thread safety looks correct: ConcurrentHashMap-backed Set and SessionData.computeIfAbsent provide atomic initialization.
No new dependencies introduced.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of Guillaume Nodet

Reviewed 3 PRs: apache#12454 (re-review), apache#11502 (new), apache#11405 (new). Added 2 new dependabot PRs to skip list. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

gnodet

New TempFileService API with lifecycle cleanup — solid concept for managing build temp files. All findings below were independently verified (7/7 confirmed).

Note: a maintainer (gnodet) already submitted CHANGES_REQUESTED in November 2025, and these issues remain unaddressed after 8+ months.

Convention violations:

@nonnull on void returns (high) — register() and cleanup() apply @Nonnull to the void return type. Existing services apply it to parameters instead.
Missing @experimental (medium) — All 20+ Service interfaces carry @Experimental. Also missing @since 4.1.0.
KEEP_PROP naming (medium) — All 113 other constants use the MAVEN_ prefix. Should be MAVEN_TEMPFILE_KEEP. Also missing @Config and @since 4.1.0. (Already noted by gnodet in Nov 2025 review.)
Boolean.getBoolean limitation (medium) — Only reads JVM -D properties, not Maven session properties from pom.xml/profiles/settings.xml. Should be documented if intentional.
Inline logger (low) — TempFileCleanupParticipant creates logger inline; DefaultTempFileService uses standard private static final Logger.
Missing parameter annotations (low) — session, directory, prefix, suffix parameters lack @Nonnull/@Nullable.
System.setProperty in test (low) — Mutates global JVM state; @AfterEach cleanup present but can still cause flakiness under parallel execution. No test for TempFileCleanupParticipant.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

gnodet · 2026-07-24T16:04:33Z

+     * Registers an externally created path for cleanup at session end.
+     */
+    @Nonnull
+    void register(Session session, Path path);


@Nonnull on a void return type is semantically meaningless. In existing services (ArtifactDeployer.deploy, ArtifactManager.setPath), @Nonnull is applied to parameters, not void returns.

Same issue on cleanup() below.

Suggested change

void register(Session session, Path path);

void register(@Nonnull Session session, @Nonnull Path path);

gnodet · 2026-07-24T16:04:33Z

+     * System property to keep temp material for diagnostics.
+     *
+     */
+    public static final String KEEP_PROP = "maven.tempfile.keep";


All 113 other constants in this file use the MAVEN_ prefix (MAVEN_HOME, MAVEN_CACHE_STATS, MAVEN_REPO_LOCAL, etc.). This should be MAVEN_TEMPFILE_KEEP. Also missing @since 4.1.0 and @Config annotation (71 other constants have @Config).

Suggested change

public static final String KEEP_PROP = "maven.tempfile.keep";

/**

* System property to keep temp material for diagnostics.

*

* @since 4.1.0

*/

@Config(type = "java.lang.Boolean", defaultValue = "false")

public static final String MAVEN_TEMPFILE_KEEP = "maven.tempfile.keep";

TempFileService with session-scoped tracking Auto-clean temp files/d…

850754f

…irs on afterSessionEnd; opt-out via -Dmaven.tempfile.keep Add tests and minimal SessionData map stub

arturobernalg mentioned this pull request Nov 7, 2025

Introduce TempFileService and lifecycle cleanup participant for Maven 4. #11389

Closed

3 tasks

gnodet requested changes Nov 18, 2025

View reviewed changes

gnodet added this to the 4.1.0 milestone Nov 18, 2025

gnodet added the enhancement New feature or request label Nov 18, 2025

gnodet changed the title ~~Introduce TempFileService and lifecycle cleanup participant for Maven 3.~~ Introduce TempFileService and lifecycle cleanup participant Dec 3, 2025

gnodet added the mvn4 label Jun 22, 2026

gnodet reviewed Jul 10, 2026

View reviewed changes

gnodet reviewed Jul 24, 2026

View reviewed changes

Navigation Menu

Uh oh!

Introduce TempFileService and lifecycle cleanup participant - #11405

Introduce TempFileService and lifecycle cleanup participant#11405
arturobernalg wants to merge 1 commit into
apache:masterfrom
arturobernalg:11384-master

arturobernalg commented Nov 7, 2025

Uh oh!

gnodet commented Nov 7, 2025

Uh oh!

arturobernalg commented Nov 8, 2025

Uh oh!

gnodet left a comment

Uh oh!

gnodet Nov 7, 2025

Uh oh!

gnodet left a comment

Uh oh!

gnodet left a comment

Uh oh!

gnodet Jul 24, 2026

Uh oh!

gnodet Jul 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	void register(Session session, Path path);
	void register(@Nonnull Session session, @Nonnull Path path);

-    public static final String KEEP_PROP = "maven.tempfile.keep";
+    /**
+     * System property to keep temp material for diagnostics.
+     *
+     * @since 4.1.0
+     */
+    @Config(type = "java.lang.Boolean", defaultValue = "false")
+    public static final String MAVEN_TEMPFILE_KEEP = "maven.tempfile.keep";

Uh oh!

Conversation

arturobernalg commented Nov 7, 2025

Uh oh!

gnodet commented Nov 7, 2025

Uh oh!

arturobernalg commented Nov 8, 2025

Uh oh!

gnodet left a comment

Choose a reason for hiding this comment

Uh oh!

gnodet Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

gnodet left a comment

Choose a reason for hiding this comment

Review: Introduce TempFileService and lifecycle cleanup participant

High

Medium

Low

Notes

Uh oh!

gnodet left a comment

Choose a reason for hiding this comment

Uh oh!

gnodet Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

gnodet Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants